logo

Back to Help Home Page.

GET Api/WebHookResults?page={page}&pageSize={pageSize}&success={success}&withErrorMessage={withErrorMessage}&createdSinceUTC={createdSinceUTC}&reportId={reportId}&httpStatusCode[0]={httpStatusCode[0]}&httpStatusCode[1]={httpStatusCode[1]}

Retrieves the results from the called webhooks linked to provided login/business. example: GET api/Webhookresults?httpStatusCode=404&httpStatusCode=401&page=0&pageSize=100&createdSinceUTC=2021-01-01T11:01 example: GET api/Webhookresults

Request Information

URI Parameters

NameDescriptionTypeAdditional information

page

integer

Default value is 0

pageSize

integer

Default value is 1000

success

boolean

None.

withErrorMessage

boolean

None.

createdSinceUTC

date

None.

reportId

integer

None.

httpStatusCode

Collection of integer

None.

Body Parameters

None.

Response Information

Resource Description

A list of webhook results.

ChappReport.Site.Areas.Api.Models.V1.WebhookResultV1ModelResponse
NameDescriptionTypeAdditional information

WebhookResults

Collection of ChappReport.Site.Areas.Api.Models.V1.WebhookResultV1Model

None.

Total

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "WebhookResults": [
    {
      "Id": 1001,
      "Url": "https://yourcompany.com/Chapps/Customer/12/Report/84651?flowStatus=InProgress",
      "HttpStatusCode": 200,
      "Success": true,
      "DateTimeUtc": "2021-09-28T11:28:05"
    },
    {
      "Id": 1002,
      "Url": "https://yourcompany.com/Chapps/Customer/12/Report/84651?flowStatus=InProgress",
      "HttpStatusCode": 401,
      "Success": false,
      "DateTimeUtc": "2021-09-28T11:29:06"
    },
    {
      "Id": 1003,
      "Url": "https://yourcompany.com/Chapps/Customer/12/Report/84651?flowStatus=Completed",
      "ErrorMessage": "Request timed out",
      "Success": false,
      "DateTimeUtc": "2021-09-28T11:30:07"
    }
  ],
  "Total": 3
}

application/xml, text/xml

Sample:
<WebhookResultV1ModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models.V1">
  <Total>3</Total>
  <WebhookResults>
    <WebhookResultV1Model>
      <DateTimeUtc>2021-09-28T11:28:05</DateTimeUtc>
      <ErrorMessage i:nil="true" />
      <HttpStatusCode>200</HttpStatusCode>
      <Id>1001</Id>
      <ReportId i:nil="true" />
      <ResponseErrorBody i:nil="true" />
      <Success>true</Success>
      <Url>https://yourcompany.com/Chapps/Customer/12/Report/84651?flowStatus=InProgress</Url>
    </WebhookResultV1Model>
    <WebhookResultV1Model>
      <DateTimeUtc>2021-09-28T11:29:06</DateTimeUtc>
      <ErrorMessage i:nil="true" />
      <HttpStatusCode>401</HttpStatusCode>
      <Id>1002</Id>
      <ReportId i:nil="true" />
      <ResponseErrorBody i:nil="true" />
      <Success>false</Success>
      <Url>https://yourcompany.com/Chapps/Customer/12/Report/84651?flowStatus=InProgress</Url>
    </WebhookResultV1Model>
    <WebhookResultV1Model>
      <DateTimeUtc>2021-09-28T11:30:07</DateTimeUtc>
      <ErrorMessage>Request timed out</ErrorMessage>
      <HttpStatusCode i:nil="true" />
      <Id>1003</Id>
      <ReportId i:nil="true" />
      <ResponseErrorBody i:nil="true" />
      <Success>false</Success>
      <Url>https://yourcompany.com/Chapps/Customer/12/Report/84651?flowStatus=Completed</Url>
    </WebhookResultV1Model>
  </WebhookResults>
</WebhookResultV1ModelResponse>